Create license.md #82
Conversation
WalkthroughThe changes include the addition of new entries to an existing wordlist file and the introduction of a new licensing document for FalkorDB. The wordlist now includes terms such as Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (3)
.wordlist.txt (1)
Line range hint
1-400: Remove duplicate entry and fix alphabetical orderingThe wordlist contains the following issues:
- Duplicate entries for "falkorDB" (one capitalized, one lowercase)
- Some terms appear to be out of alphabetical order
- Multiple trailing blank lines at the end of file
Apply these changes:
- Keep only one entry for "FalkorDB" (preferably the capitalized version since it's a product name)
- Ensure all entries are in alphabetical order
- Remove extra blank lines at the end of file, keeping just one
Here's a script to help identify out-of-order entries:
#!/bin/bash # Description: Check for alphabetical ordering issues in the wordlist # Create a sorted version and compare with original sort .wordlist.txt | diff - .wordlist.txt # Find duplicate entries (case-insensitive) sort -f .wordlist.txt | uniq -i -d🧰 Tools
🪛 LanguageTool
[uncategorized] ~29-~29: Ger doublet «GraphBLAS GraphBlas».
Context: ...BQAChain Gadepally Geospatial GPL GrAPL GraphBLAS GraphBlas GraphRAG IDF IDentifier IPDPS ISC Imple...(GER_DOUBLET)
license.md (2)
9-9: Fix typos and standardize license name formattingThere are a few minor issues to address:
- Remove the duplicate "the" in the sentence
- Use consistent hyphenation for "Server-Side Public License" as it's a compound adjective
-FalkorDB is licensed under the the [Server Side Public License v1 (SSPLv1)] +FalkorDB is licensed under the [Server-Side Public License v1 (SSPLv1)]🧰 Tools
🪛 LanguageTool
[duplication] ~9-~9: Possible typo: you repeated a word
Context: ...rDB License FalkorDB is licensed under the the [Server Side Public License v1 (SSPLv1)...(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~9-~9: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...se FalkorDB is licensed under the the [Server Side Public License v1 (SSPLv1)](https://git...(EN_COMPOUND_ADJECTIVE_INTERNAL)
15-15: Standardize terminology throughout the documentFor consistency and professionalism:
- Standardize "Server-Side Public License" with hyphens throughout
- Use consistent hyphenation for "open-source" when used as an adjective
Example changes needed:
-Server Side Public License +Server-Side Public License -open source your code +open-source your codeAlso applies to: 23-23, 27-27, 31-31, 35-35, 39-39, 43-43
🧰 Tools
🪛 LanguageTool
[uncategorized] ~15-~15: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...FalkorDB is licensed under SSPLv1? The Server Side Public License (SSPLv1) is designed to ...(EN_COMPOUND_ADJECTIVE_INTERNAL)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
.wordlist.txt(3 hunks)license.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
license.md
[duplication] ~9-~9: Possible typo: you repeated a word
Context: ...rDB License FalkorDB is licensed under the the [Server Side Public License v1 (SSPLv1)...
(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~9-~9: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...se FalkorDB is licensed under the the [Server Side Public License v1 (SSPLv1)](https://git...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~11-~11: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: .../FalkorDB/blob/master/LICENSE.txt). ## FalkorDB Licensing FAQ: Understanding the SSPLv1...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~15-~15: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...FalkorDB is licensed under SSPLv1? The Server Side Public License (SSPLv1) is designed to ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
🔇 Additional comments (2)
.wordlist.txt (1)
28-28: LGTM: New entries are appropriate
The addition of technical terms GPL, SDKs, and codebase is appropriate for the project's documentation and aligns with the introduction of the license file.
Also applies to: 81-81, 110-110
license.md (1)
9-9: Verify license reference and consider using a stable branch
The license URL points to the master branch, which could change. Consider:
- Linking to a specific commit or release tag
- Verifying that the referenced license text matches the official SSPLv1
🧰 Tools
🪛 LanguageTool
[duplication] ~9-~9: Possible typo: you repeated a word
Context: ...rDB License FalkorDB is licensed under the the [Server Side Public License v1 (SSPLv1)...
(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~9-~9: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...se FalkorDB is licensed under the the [Server Side Public License v1 (SSPLv1)](https://git...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
| If your closed-source project does not make FalkorDB available to external users as part of a service, you can use it without open-sourcing the rest of your code. However, if you provide FalkorDB as part of a service, the SSPLv1 requires you to open-source your codebase associated with the service. | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Clarify the scope of "service" and code release requirements
The current wording about what constitutes a "service" and which parts of the code need to be open-sourced could be clearer. Consider adding specific examples or scenarios to help users better understand their obligations.
Suggested addition after line 32:
+For example:
+- If you run FalkorDB as an internal database, you don't need to open-source your application
+- If you offer FalkorDB as a managed database service, you must open-source the service implementation
+- If you embed FalkorDB in a self-hosted product, you don't need to open-source the productAlso applies to: 27-28, 31-32
Fix #81
Summary by CodeRabbit
New Features
GPL,SDKs,codebase, andfalkorDB.license.md, outlining terms for using FalkorDB under the Server Side Public License v1 (SSPLv1).Documentation
license.mdfile provides detailed information on licensing implications, modification rights, and usage conditions for FalkorDB.